Update ctl tool documentation#6172
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates IAM-CTL promotion documentation to cover additional resource types and clarify operational behavior via new logging and resource-specific guidance.
Changes:
- Expanded supported IAM-CTL resource type list (with version-gated additions).
- Added new documentation sections for unified logging and resource-type-specific caveats.
- Embedded the new sections into multiple “promote configurations” pages across product/version docs.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| en/includes/deploy/ctl-tool/resource-types-7.x.md | Adds additional resource types and version-gated entries for IAM-CTL propagation docs. |
| en/includes/deploy/ctl-tool/resource-specific-notes.md | New include documenting resource-specific import/export behaviors and caveats. |
| en/includes/deploy/ctl-tool/logging.md | New include documenting IAM-CTL logging configuration and safety warning. |
| en/includes/deploy/ctl-tool/getting-started-7.x.md | Extends required M2M application scopes list for newly supported resources, with version gating. |
| en/identity-server/next/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.3.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.2.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.1.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/7.0.0/docs/deploy/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
| en/identity-server/5.11.0/docs/setup/promote-configurations.md | Adds a logging section directly (non-include) for 5.11.0 docs. |
| en/asgardeo/docs/guides/your-asgardeo/manage-environments/promote-configurations.md | Includes the new logging and resource-specific notes sections. |
Comments suppressed due to low confidence (1)
en/includes/deploy/ctl-tool/resource-types-7.x.md:1
- The resource type list includes
Email Templatesunconditionally, butgetting-started-7.x.mdgates Email Template API scopes toserver_version == \"7.0\"and usesNotification TemplateAPIs for>= 7.1. To avoid conflicting guidance, align the resource type list with the same version gating (either gateEmail Templatesto the versions where it exists, or clarify how it maps to notification templates in newer versions).
### Supported resource types
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds shared IAM-CTL logging and resource-specific promotion notes; expands ctl-tool resource-type and permission references; embeds logging in Identity Server 5.11.0; and inserts include directives into multiple promote-configurations guides to integrate the shared content. ChangesCTL-Tool Documentation Enhancement
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
en/includes/deploy/ctl-tool/logging.md (1)
23-23: 💤 Low valueConsider using active voice in the property description.
The description "are logged" uses passive voice. As per coding guidelines, prefer active voice. Consider rewording to "logs HTTP request bodies" for clarity and directness.
♻️ Suggested revision
-| `LOG_REQUEST_PAYLOADS` | `true`, `false` | `false` | When set to `true`, HTTP request bodies are logged at `DEBUG` level for POST and PUT requests. | +| `LOG_REQUEST_PAYLOADS` | `true`, `false` | `false` | When set to `true`, logs HTTP request bodies at `DEBUG` level for POST and PUT requests. |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/logging.md` at line 23, Update the description for the LOG_REQUEST_PAYLOADS property to use active voice: replace "HTTP request bodies are logged at `DEBUG` level for POST and PUT requests" with an active phrasing such as "logs HTTP request bodies at `DEBUG` level for POST and PUT requests" while preserving the flag name LOG_REQUEST_PAYLOADS and the behavior details (DEBUG level, POST and PUT).en/includes/deploy/ctl-tool/resource-specific-notes.md (1)
3-3: 💤 Low valueSimplify wordy phrase per coding guidelines.
The phrase "to be aware of when using" is verbose. As per coding guidelines, use concise language. Consider "to note when using" or simply "when using".
♻️ Suggested revision
-The following notes describe resource-type-specific behavior to be aware of when using IAM-CTL. +The following notes describe resource-type-specific behavior when using IAM-CTL.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 3, Replace the verbose phrase "to be aware of when using" in the document with a concise alternative such as "to note when using" or simply "when using"; locate the sentence that currently reads "The following notes describe resource-type-specific behavior to be aware of when using IAM-CTL." and update it to "The following notes describe resource-type-specific behavior to note when using IAM-CTL." (or "when using IAM-CTL") to comply with the concise wording guideline.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/identity-server/5.11.0/docs/setup/promote-configurations.md`:
- Line 168: Replace the bold inline heading "**toolConfig.json**" with the
tab-style include label === "toolConfig.json" and ensure the following JSON
sample is written as a code block using the tab syntax: add a blank line after
=== "toolConfig.json" and start the JSON block with ```json while indenting the
JSON content by 4 spaces (so the code block content is tab-syntax compliant);
locate the literal "**toolConfig.json**" in the file to make this change.
---
Nitpick comments:
In `@en/includes/deploy/ctl-tool/logging.md`:
- Line 23: Update the description for the LOG_REQUEST_PAYLOADS property to use
active voice: replace "HTTP request bodies are logged at `DEBUG` level for POST
and PUT requests" with an active phrasing such as "logs HTTP request bodies at
`DEBUG` level for POST and PUT requests" while preserving the flag name
LOG_REQUEST_PAYLOADS and the behavior details (DEBUG level, POST and PUT).
In `@en/includes/deploy/ctl-tool/resource-specific-notes.md`:
- Line 3: Replace the verbose phrase "to be aware of when using" in the document
with a concise alternative such as "to note when using" or simply "when using";
locate the sentence that currently reads "The following notes describe
resource-type-specific behavior to be aware of when using IAM-CTL." and update
it to "The following notes describe resource-type-specific behavior to note when
using IAM-CTL." (or "when using IAM-CTL") to comply with the concise wording
guideline.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 7d1a1490-c6a7-4d6a-99ec-638fe80e4a62
📒 Files selected for processing (11)
en/asgardeo/docs/guides/your-asgardeo/manage-environments/promote-configurations.mden/identity-server/5.11.0/docs/setup/promote-configurations.mden/identity-server/7.0.0/docs/deploy/promote-configurations.mden/identity-server/7.1.0/docs/deploy/promote-configurations.mden/identity-server/7.2.0/docs/deploy/promote-configurations.mden/identity-server/7.3.0/docs/deploy/promote-configurations.mden/identity-server/next/docs/deploy/promote-configurations.mden/includes/deploy/ctl-tool/getting-started-7.x.mden/includes/deploy/ctl-tool/logging.mden/includes/deploy/ctl-tool/resource-specific-notes.mden/includes/deploy/ctl-tool/resource-types-7.x.md
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
en/includes/deploy/ctl-tool/resource-specific-notes.md (6)
80-80: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winConvert passive voice to active voice.
The paragraph contains multiple passive constructions that reduce directness:
- "are not exported by IAM-CTL"
- "will be removed from the exported workflow"
- "will also be removed"
- "will be removed from the workflow on import"
As per coding guidelines, use active voice and present tense.
✍️ Suggested rewrite
-Users included in approval steps are not exported by IAM-CTL. These users will be removed from the exported workflow, and any approval steps that contained only users will also be removed. As a result, these users and steps will be removed from the workflow on import. +IAM-CTL does not export users included in approval steps. IAM-CTL removes these users from the exported workflow and also removes any approval steps that contain only users. As a result, import removes these users and steps from the workflow.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 80, Rewrite the paragraph to use active voice and present tense: state that "IAM-CTL does not export users included in approval steps" and that "IAM-CTL removes those users from the exported workflow and removes any approval steps that contain only users," and finish by clarifying that "import does not restore those users or steps." Update the sentences replacing passive phrases ("are not exported by IAM-CTL", "will be removed from the exported workflow", "will also be removed", "will be removed from the workflow on import") with the active constructions above.
26-26: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winConvert passive voice to active voice.
The sentence contains multiple passive constructions: "are not exported by IAM-CTL" and "will be removed from the connector on import." As per coding guidelines, use active voice.
✍️ Suggested rewrite
-Group-based password expiry rules of the password expiry connector are not exported by IAM-CTL. As a result, these rules will be removed from the connector on import, when **`ALLOW_DELETE`** is enabled. +IAM-CTL does not export group-based password expiry rules of the password expiry connector. As a result, when you enable **`ALLOW_DELETE`**, import removes these rules from the connector.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 26, Rewrite the sentence to use active voice: replace "Group-based password expiry rules of the password expiry connector are not exported by IAM-CTL. As a result, these rules will be removed from the connector on import, when **`ALLOW_DELETE`** is enabled." with an active formulation that names the actor (IAM-CTL) and the action (does not export / removes), e.g. "IAM-CTL does not export group-based password expiry rules from the password expiry connector, so importing with **`ALLOW_DELETE`** enabled will remove those rules from the connector." Ensure the revised sentence appears in resource-specific-notes.md and retains the **`ALLOW_DELETE`** emphasis.
10-10: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winConvert passive voice to active voice.
"Users and groups assigned to roles are not exported or imported by IAM-CTL" uses passive voice. As per coding guidelines, prefer active voice.
✍️ Suggested rewrite
-Users and groups assigned to roles are not exported or imported by IAM-CTL. +IAM-CTL does not export or import users and groups assigned to roles.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 10, Change the passive sentence "Users and groups assigned to roles are not exported or imported by IAM-CTL" to active voice in the file where that sentence appears; specifically, update the line so the subject is "IAM-CTL" (e.g., "IAM-CTL does not export or import users and groups assigned to roles") to make the statement active and clearer.
18-18: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winReplace ambiguous pronoun and convert to active voice.
The pronoun "it" is ambiguous and the phrase "from being propagated" is passive. As per coding guidelines, avoid ambiguous pronouns by replacing them with explicit nouns, and use active voice.
✍️ Suggested rewrite
-When propagating user stores, do not exclude the local claim dialect (`http://wso2.org/claims`). Excluding it will prevent new claim attribute mappings of user stores from being propagated. +When propagating user stores, do not exclude the local claim dialect (`http://wso2.org/claims`). Excluding the local claim dialect prevents IAM-CTL from propagating new claim attribute mappings of user stores.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 18, The sentence "Excluding it will prevent new claim attribute mappings of user stores from being propagated." uses an ambiguous pronoun and passive voice; replace it with an explicit, active-voice sentence referencing the local claim dialect text in the diff. For example, change that sentence to explicitly name "the local claim dialect (http://wso2.org/claims)" and use active voice such as "Excluding the local claim dialect (http://wso2.org/claims) prevents propagation of new claim attribute mappings to user stores." Update the sentence near "When propagating user stores, do not exclude the local claim dialect (`http://wso2.org/claims`)." accordingly.
22-22: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winConvert passive voice to active voice.
The phrase "from being propagated" is passive. As per coding guidelines, use active voice.
✍️ Suggested rewrite
-When propagating applications, do not exclude roles. Excluding roles will prevent new application roles from being propagated. +When propagating applications, do not exclude roles. Excluding roles prevents IAM-CTL from propagating new application roles.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 22, The sentence "Excluding roles will prevent new application roles from being propagated." uses passive voice; update the line in resource-specific-notes.md (the sentence starting with "Excluding roles will prevent...") to active voice—for example: "Excluding roles prevents us from propagating new application roles." Replace the original sentence with this active-voice version (or an equivalent active construction) to comply with the style guideline.
32-32: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winConvert passive voice to active voice.
The sentence contains passive constructions: "are not exported by IAM-CTL" and "will be removed from the identity provider on import." As per coding guidelines, use active voice.
✍️ Suggested rewrite
-Outbound provisioning groups of outbound provisioning connectors are not exported by IAM-CTL. As a result, these groups will be removed from the identity provider on import. +IAM-CTL does not export outbound provisioning groups of outbound provisioning connectors. As a result, import removes these groups from the identity provider.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 32, Rewrite the passive sentence so the subject performs the action: replace "Outbound provisioning groups of outbound provisioning connectors are not exported by IAM-CTL. As a result, these groups will be removed from the identity provider on import." with an active-voice sentence that names IAM-CTL as the actor and describes the consequence, e.g. start with "IAM-CTL does not export outbound provisioning groups of outbound provisioning connectors, so importing removes these groups from the identity provider." Update the sentence containing "Outbound provisioning groups of outbound provisioning connectors", "IAM-CTL", and "identity provider on import".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/includes/deploy/ctl-tool/resource-specific-notes.md`:
- Line 3: Change the passive sentence "The following notes describe
resource-type-specific behavior to be aware of when using IAM-CTL." to active
voice and present tense; replace it with "Note the following
resource-type-specific behavior when you use IAM-CTL." in the same paragraph
(look for the exact original string in resource-specific-notes.md and update
it).
- Line 6: Rewrite the paragraph to use active voice and present tense: change
"Users and groups are considered dynamic configurations" to "IAM-CTL treats
users and groups as dynamic configurations", replace "importing into a target
environment will remove this data from the affected resource" with "import
removes this data from the affected resource in the target environment", and
update the surrounding sentences so the actor ("IAM-CTL" or "import") performs
the actions (e.g., "IAM-CTL strips that data during export" → keep as active)
and the guidance lines remain clear about using IAM-CTL for initial creation,
adding dynamic configurations manually, and using EXCLUDE for future imports.
- Line 58: The sentence uses passive voice ("are stripped on export and are not
stored in the exported files"); rewrite it in active voice by making IAM-CTL the
subject. Replace that clause with an active formulation such as "IAM-CTL strips
these attributes on export and does not store them in the exported files,
because they are environment-specific and not portable," updating the line in
resource-specific-notes.md that currently reads "These attributes are stripped
on export and are not stored in the exported files, as they are
environment-specific and not portable."
- Line 42: Replace the undefined acronym and passive phrasing in the sentence
that starts with "When IAM-CTL creates organizations using M2M app credentials":
define M2M on first use as "machine-to-machine (M2M)" and convert to active
voice — e.g., "When IAM-CTL creates organizations using machine-to-machine (M2M)
app credentials, it does not assign any user as the creator, so no user has
access to the newly created organization; you can manually assign an
organization admin..." — keep the existing link text and target unchanged;
update the sentence in the resource-specific-notes content where "M2M" and the
passive clause appear.
---
Outside diff comments:
In `@en/includes/deploy/ctl-tool/resource-specific-notes.md`:
- Line 80: Rewrite the paragraph to use active voice and present tense: state
that "IAM-CTL does not export users included in approval steps" and that
"IAM-CTL removes those users from the exported workflow and removes any approval
steps that contain only users," and finish by clarifying that "import does not
restore those users or steps." Update the sentences replacing passive phrases
("are not exported by IAM-CTL", "will be removed from the exported workflow",
"will also be removed", "will be removed from the workflow on import") with the
active constructions above.
- Line 26: Rewrite the sentence to use active voice: replace "Group-based
password expiry rules of the password expiry connector are not exported by
IAM-CTL. As a result, these rules will be removed from the connector on import,
when **`ALLOW_DELETE`** is enabled." with an active formulation that names the
actor (IAM-CTL) and the action (does not export / removes), e.g. "IAM-CTL does
not export group-based password expiry rules from the password expiry connector,
so importing with **`ALLOW_DELETE`** enabled will remove those rules from the
connector." Ensure the revised sentence appears in resource-specific-notes.md
and retains the **`ALLOW_DELETE`** emphasis.
- Line 10: Change the passive sentence "Users and groups assigned to roles are
not exported or imported by IAM-CTL" to active voice in the file where that
sentence appears; specifically, update the line so the subject is "IAM-CTL"
(e.g., "IAM-CTL does not export or import users and groups assigned to roles")
to make the statement active and clearer.
- Line 18: The sentence "Excluding it will prevent new claim attribute mappings
of user stores from being propagated." uses an ambiguous pronoun and passive
voice; replace it with an explicit, active-voice sentence referencing the local
claim dialect text in the diff. For example, change that sentence to explicitly
name "the local claim dialect (http://wso2.org/claims)" and use active voice
such as "Excluding the local claim dialect (http://wso2.org/claims) prevents
propagation of new claim attribute mappings to user stores." Update the sentence
near "When propagating user stores, do not exclude the local claim dialect
(`http://wso2.org/claims`)." accordingly.
- Line 22: The sentence "Excluding roles will prevent new application roles from
being propagated." uses passive voice; update the line in
resource-specific-notes.md (the sentence starting with "Excluding roles will
prevent...") to active voice—for example: "Excluding roles prevents us from
propagating new application roles." Replace the original sentence with this
active-voice version (or an equivalent active construction) to comply with the
style guideline.
- Line 32: Rewrite the passive sentence so the subject performs the action:
replace "Outbound provisioning groups of outbound provisioning connectors are
not exported by IAM-CTL. As a result, these groups will be removed from the
identity provider on import." with an active-voice sentence that names IAM-CTL
as the actor and describes the consequence, e.g. start with "IAM-CTL does not
export outbound provisioning groups of outbound provisioning connectors, so
importing removes these groups from the identity provider." Update the sentence
containing "Outbound provisioning groups of outbound provisioning connectors",
"IAM-CTL", and "identity provider on import".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: c7439b35-d291-4f7e-8ed1-ac2b7bfb1d1e
📒 Files selected for processing (2)
en/identity-server/5.11.0/docs/setup/promote-configurations.mden/includes/deploy/ctl-tool/resource-specific-notes.md
✅ Files skipped from review due to trivial changes (1)
- en/identity-server/5.11.0/docs/setup/promote-configurations.md
There was a problem hiding this comment.
🧹 Nitpick comments (5)
en/includes/deploy/ctl-tool/resource-specific-notes.md (5)
80-80: ⚡ Quick winConvert passive voice to active voice.
The sentence uses passive voice with a "by" agent. Make IAM-CTL the subject for directness and convert "will be removed" to active present tense.
✍️ Suggested rewrite
-Users included in approval steps are not exported by IAM-CTL. These users will be removed from the exported workflow, and any approval steps that contained only users will also be removed. As a result, these users and steps will be removed from the workflow on import. +IAM-CTL does not export users included in approval steps. Export removes these users from the workflow, and also removes any approval steps that contain only users. As a result, import removes these users and steps from the workflow.As per coding guidelines: "Use active voice and present tense; use passive voice only when the actor is unknown or unimportant."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 80, Rewrite the passive sentence so IAM-CTL is the subject and use active present tense: change "Users included in approval steps are not exported by IAM-CTL. These users will be removed from the exported workflow, and any approval steps that contained only users will also be removed. As a result, these users and steps will be removed from the workflow on import." to an active construction that starts with "IAM-CTL" (for example: "IAM-CTL does not export users included in approval steps; it removes those users from the exported workflow and also removes any approval steps that contain only users, so they are removed on import."), ensuring present tense and direct voice throughout.
46-46: ⚡ Quick winReplace "Alternatively" with more concise wording.
Vale reports that "Alternatively" is too wordy. Use a more concise alternative to improve readability.
✍️ Suggested rewrite
-Alternatively, to assign a creator at import time, configure **`CREATOR_ID`** and **`CREATOR_USERNAME`** under `ORGANIZATIONS` in `toolConfig.json`. +To assign a creator at import time, configure **`CREATOR_ID`** and **`CREATOR_USERNAME`** under `ORGANIZATIONS` in `toolConfig.json`.As per coding guidelines: "Use plain language and short sentences."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 46, Replace the word "Alternatively" at the start of the sentence about assigning a creator with a more concise connector (e.g., "To assign a creator at import time, configure ...") so the line reads succinctly and still references CREATOR_ID and CREATOR_USERNAME under ORGANIZATIONS in toolConfig.json; update the string in resource-specific-notes.md where that sentence occurs to use the shorter phrasing while keeping the same configuration keys and file name.
32-32: ⚡ Quick winConvert passive voice to active voice.
The sentence uses passive voice with a "by" agent. Make IAM-CTL the subject for directness.
✍️ Suggested rewrite
-Outbound provisioning groups of outbound provisioning connectors are not exported by IAM-CTL. As a result, these groups will be removed from the identity provider on import. +IAM-CTL does not export outbound provisioning groups of outbound provisioning connectors. As a result, import removes these groups from the identity provider.As per coding guidelines: "Use active voice and present tense; use passive voice only when the actor is unknown or unimportant."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 32, Change the passive sentence "Outbound provisioning groups of outbound provisioning connectors are not exported by IAM-CTL. As a result, these groups will be removed from the identity provider on import." to active voice with IAM-CTL as the subject; for example, replace it with a single active sentence such as "IAM-CTL does not export outbound provisioning groups of outbound provisioning connectors, so importing will remove these groups from the identity provider." Update the line in resource-specific-notes.md where that sentence appears.
10-10: ⚡ Quick winConvert passive voice to active voice.
The sentence uses passive voice with a "by" agent. Make IAM-CTL the subject for directness.
✍️ Suggested rewrite
-Users and groups assigned to roles are not exported or imported by IAM-CTL. +IAM-CTL does not export or import users and groups assigned to roles.As per coding guidelines: "Use active voice and present tense; use passive voice only when the actor is unknown or unimportant."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 10, Change the passive sentence "Users and groups assigned to roles are not exported or imported by IAM-CTL." to active voice with IAM-CTL as the subject; replace it with a direct statement such as "IAM-CTL does not export or import users and groups assigned to roles." Ensure the updated text is applied where the current sentence appears in resource-specific-notes.md and preserves the original meaning and tense.
26-26: ⚡ Quick winConvert passive voice to active voice.
The sentence uses passive voice with a "by" agent. Make IAM-CTL the subject for directness.
✍️ Suggested rewrite
-Group-based password expiry rules of the password expiry connector are not exported by IAM-CTL. As a result, these rules will be removed from the connector on import, when **`ALLOW_DELETE`** is enabled. +IAM-CTL does not export group-based password expiry rules of the password expiry connector. As a result, import removes these rules from the connector when **`ALLOW_DELETE`** is enabled.As per coding guidelines: "Use active voice and present tense; use passive voice only when the actor is unknown or unimportant."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/deploy/ctl-tool/resource-specific-notes.md` at line 26, Rewrite the sentence to use active voice with IAM-CTL as the subject: change "Group-based password expiry rules of the password expiry connector are not exported by IAM-CTL. As a result, these rules will be removed from the connector on import, when **`ALLOW_DELETE`** is enabled." to a direct active construction mentioning "IAM-CTL" and "**`ALLOW_DELETE`**" (for example: "IAM-CTL does not export group-based password expiry rules from the password expiry connector; when **`ALLOW_DELETE`** is enabled, IAM-CTL will remove these rules on import."). Ensure the phrase "password expiry connector", "group-based password expiry rules", "IAM-CTL", and "**`ALLOW_DELETE`**" remain present and the tense is present.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@en/includes/deploy/ctl-tool/resource-specific-notes.md`:
- Line 80: Rewrite the passive sentence so IAM-CTL is the subject and use active
present tense: change "Users included in approval steps are not exported by
IAM-CTL. These users will be removed from the exported workflow, and any
approval steps that contained only users will also be removed. As a result,
these users and steps will be removed from the workflow on import." to an active
construction that starts with "IAM-CTL" (for example: "IAM-CTL does not export
users included in approval steps; it removes those users from the exported
workflow and also removes any approval steps that contain only users, so they
are removed on import."), ensuring present tense and direct voice throughout.
- Line 46: Replace the word "Alternatively" at the start of the sentence about
assigning a creator with a more concise connector (e.g., "To assign a creator at
import time, configure ...") so the line reads succinctly and still references
CREATOR_ID and CREATOR_USERNAME under ORGANIZATIONS in toolConfig.json; update
the string in resource-specific-notes.md where that sentence occurs to use the
shorter phrasing while keeping the same configuration keys and file name.
- Line 32: Change the passive sentence "Outbound provisioning groups of outbound
provisioning connectors are not exported by IAM-CTL. As a result, these groups
will be removed from the identity provider on import." to active voice with
IAM-CTL as the subject; for example, replace it with a single active sentence
such as "IAM-CTL does not export outbound provisioning groups of outbound
provisioning connectors, so importing will remove these groups from the identity
provider." Update the line in resource-specific-notes.md where that sentence
appears.
- Line 10: Change the passive sentence "Users and groups assigned to roles are
not exported or imported by IAM-CTL." to active voice with IAM-CTL as the
subject; replace it with a direct statement such as "IAM-CTL does not export or
import users and groups assigned to roles." Ensure the updated text is applied
where the current sentence appears in resource-specific-notes.md and preserves
the original meaning and tense.
- Line 26: Rewrite the sentence to use active voice with IAM-CTL as the subject:
change "Group-based password expiry rules of the password expiry connector are
not exported by IAM-CTL. As a result, these rules will be removed from the
connector on import, when **`ALLOW_DELETE`** is enabled." to a direct active
construction mentioning "IAM-CTL" and "**`ALLOW_DELETE`**" (for example:
"IAM-CTL does not export group-based password expiry rules from the password
expiry connector; when **`ALLOW_DELETE`** is enabled, IAM-CTL will remove these
rules on import."). Ensure the phrase "password expiry connector", "group-based
password expiry rules", "IAM-CTL", and "**`ALLOW_DELETE`**" remain present and
the tense is present.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 0208e7ed-0dc1-4ca5-93d1-4f34d33ecc67
📒 Files selected for processing (1)
en/includes/deploy/ctl-tool/resource-specific-notes.md
Purpose
This PR updates CTL tool documentation to reflect the support added to new resource types and the logging improvements.
Related to https://github.com/wso2-enterprise/iam-product-management/issues/662
Related PRs
Test environment
Security checks